<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>QuantumLibrary: Bloomberg::quantum::ICoroContextBase Interface Reference</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../jquery.js"></script>
<script type="text/javascript" src="../../dynsections.js"></script>
<link href="../../navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../resize.js"></script>
<script type="text/javascript" src="../../navtreedata.js"></script>
<script type="text/javascript" src="../../navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(initResizable);
/* @license-end */</script>
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../search/searchdata.js"></script>
<script type="text/javascript" src="../../search/search.js"></script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">QuantumLibrary
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('../../',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('de/d67/structBloomberg_1_1quantum_1_1ICoroContextBase.html','../../');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="../../d5/d77/structBloomberg_1_1quantum_1_1ICoroContextBase-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">Bloomberg::quantum::ICoroContextBase Interface Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p>Exposes methods to manipulate the coroutine context, especially future wait methods.  
 <a href="../../de/d67/structBloomberg_1_1quantum_1_1ICoroContextBase.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="../../d8/d23/quantum__icoro__context__base_8h_source.html">quantum_icoro_context_base.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for Bloomberg::quantum::ICoroContextBase:</div>
<div class="dyncontent">
 <div class="center">
  <img src="../../de/d67/structBloomberg_1_1quantum_1_1ICoroContextBase.png" usemap="#Bloomberg::quantum::ICoroContextBase_map" alt=""/>
  <map id="Bloomberg::quantum::ICoroContextBase_map" name="Bloomberg::quantum::ICoroContextBase_map">
<area href="../../d8/db0/structBloomberg_1_1quantum_1_1IContextBase.html" title="This interface exposes shared functionality between IThreadContext and ICoroContext." alt="Bloomberg::quantum::IContextBase" shape="rect" coords="0,0,250,24"/>
<area href="../../d3/d63/structBloomberg_1_1quantum_1_1ICoroSync.html" title="Provides an interface to facilitate &#39;implicit&#39; coroutine yielding within other primitives such as mut..." alt="Bloomberg::quantum::ICoroSync" shape="rect" coords="260,0,510,24"/>
<area href="../../d5/dd1/structBloomberg_1_1quantum_1_1ICoroContext.html" title="Exposes methods to manipulate the coroutine context." alt="Bloomberg::quantum::ICoroContext&lt; RET &gt;" shape="rect" coords="130,112,380,136"/>
<area href="../../d8/df7/classBloomberg_1_1quantum_1_1Context.html" title="Concrete class representing a coroutine or a thread context." alt="Bloomberg::quantum::Context&lt; RET &gt;" shape="rect" coords="130,168,380,192"/>
  </map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:aa480ed235fb4eddf594fe5731c54ccab"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/d67/structBloomberg_1_1quantum_1_1ICoroContextBase.html#aa480ed235fb4eddf594fe5731c54ccab">Ptr</a> = std::shared_ptr&lt; <a class="el" href="../../de/d67/structBloomberg_1_1quantum_1_1ICoroContextBase.html">ICoroContextBase</a> &gt;</td></tr>
<tr class="separator:aa480ed235fb4eddf594fe5731c54ccab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_types_structBloomberg_1_1quantum_1_1IContextBase"><td colspan="2" onclick="javascript:toggleInherit('pub_types_structBloomberg_1_1quantum_1_1IContextBase')"><img src="../../closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="../../d8/db0/structBloomberg_1_1quantum_1_1IContextBase.html">Bloomberg::quantum::IContextBase</a></td></tr>
<tr class="memitem:ac92e5d294479f777fd01f5621e4f8db9 inherit pub_types_structBloomberg_1_1quantum_1_1IContextBase"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/db0/structBloomberg_1_1quantum_1_1IContextBase.html#ac92e5d294479f777fd01f5621e4f8db9">Ptr</a> = std::shared_ptr&lt; <a class="el" href="../../d8/db0/structBloomberg_1_1quantum_1_1IContextBase.html">IContextBase</a> &gt;</td></tr>
<tr class="separator:ac92e5d294479f777fd01f5621e4f8db9 inherit pub_types_structBloomberg_1_1quantum_1_1IContextBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_types_structBloomberg_1_1quantum_1_1ICoroSync"><td colspan="2" onclick="javascript:toggleInherit('pub_types_structBloomberg_1_1quantum_1_1ICoroSync')"><img src="../../closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="../../d3/d63/structBloomberg_1_1quantum_1_1ICoroSync.html">Bloomberg::quantum::ICoroSync</a></td></tr>
<tr class="memitem:a109b2c4b7d70d53d48bb640a9d849b29 inherit pub_types_structBloomberg_1_1quantum_1_1ICoroSync"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d63/structBloomberg_1_1quantum_1_1ICoroSync.html#a109b2c4b7d70d53d48bb640a9d849b29">Ptr</a> = std::shared_ptr&lt; <a class="el" href="../../d3/d63/structBloomberg_1_1quantum_1_1ICoroSync.html">ICoroSync</a> &gt;</td></tr>
<tr class="separator:a109b2c4b7d70d53d48bb640a9d849b29 inherit pub_types_structBloomberg_1_1quantum_1_1ICoroSync"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a6790f4caa9b032241c715803201561f4"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/d67/structBloomberg_1_1quantum_1_1ICoroContextBase.html#a6790f4caa9b032241c715803201561f4">wait</a> (<a class="el" href="../../d3/d63/structBloomberg_1_1quantum_1_1ICoroSync.html#a109b2c4b7d70d53d48bb640a9d849b29">ICoroSync::Ptr</a> sync) const =0</td></tr>
<tr class="memdesc:a6790f4caa9b032241c715803201561f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Waits for the future associated with this context to be ready.  <a href="#a6790f4caa9b032241c715803201561f4">More...</a><br /></td></tr>
<tr class="separator:a6790f4caa9b032241c715803201561f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac07fda0dfbf94d1c611118d0eb77a275"><td class="memItemLeft" align="right" valign="top">virtual std::future_status&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/d67/structBloomberg_1_1quantum_1_1ICoroContextBase.html#ac07fda0dfbf94d1c611118d0eb77a275">waitFor</a> (<a class="el" href="../../d3/d63/structBloomberg_1_1quantum_1_1ICoroSync.html#a109b2c4b7d70d53d48bb640a9d849b29">ICoroSync::Ptr</a> sync, std::chrono::milliseconds timeMs) const =0</td></tr>
<tr class="memdesc:ac07fda0dfbf94d1c611118d0eb77a275"><td class="mdescLeft">&#160;</td><td class="mdescRight">Waits for the future associated with this context to be ready for a maximum of 'timeMs' milliseconds.  <a href="#ac07fda0dfbf94d1c611118d0eb77a275">More...</a><br /></td></tr>
<tr class="separator:ac07fda0dfbf94d1c611118d0eb77a275"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3cbd4fbaab81b30ae8a8ef2eaf7978bc"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/d67/structBloomberg_1_1quantum_1_1ICoroContextBase.html#a3cbd4fbaab81b30ae8a8ef2eaf7978bc">waitAt</a> (int num, <a class="el" href="../../d3/d63/structBloomberg_1_1quantum_1_1ICoroSync.html#a109b2c4b7d70d53d48bb640a9d849b29">ICoroSync::Ptr</a> sync) const =0</td></tr>
<tr class="memdesc:a3cbd4fbaab81b30ae8a8ef2eaf7978bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Waits for the future in the 'num-th' continuation context to be ready.  <a href="#a3cbd4fbaab81b30ae8a8ef2eaf7978bc">More...</a><br /></td></tr>
<tr class="separator:a3cbd4fbaab81b30ae8a8ef2eaf7978bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a15581e24f526c0dfa0b3d3d9bb204a1f"><td class="memItemLeft" align="right" valign="top">virtual std::future_status&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/d67/structBloomberg_1_1quantum_1_1ICoroContextBase.html#a15581e24f526c0dfa0b3d3d9bb204a1f">waitForAt</a> (int num, <a class="el" href="../../d3/d63/structBloomberg_1_1quantum_1_1ICoroSync.html#a109b2c4b7d70d53d48bb640a9d849b29">ICoroSync::Ptr</a> sync, std::chrono::milliseconds timeMs) const =0</td></tr>
<tr class="memdesc:a15581e24f526c0dfa0b3d3d9bb204a1f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Waits for the future in the 'num-th' continuation context to be ready for a maximum of 'timeMs' milliseconds.  <a href="#a15581e24f526c0dfa0b3d3d9bb204a1f">More...</a><br /></td></tr>
<tr class="separator:a15581e24f526c0dfa0b3d3d9bb204a1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a63d57113242dd466201d5e62a7b42cf8"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/d67/structBloomberg_1_1quantum_1_1ICoroContextBase.html#a63d57113242dd466201d5e62a7b42cf8">waitAll</a> (<a class="el" href="../../d3/d63/structBloomberg_1_1quantum_1_1ICoroSync.html#a109b2c4b7d70d53d48bb640a9d849b29">ICoroSync::Ptr</a> sync) const =0</td></tr>
<tr class="memdesc:a63d57113242dd466201d5e62a7b42cf8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait for all the futures in the continuation chain to be ready.  <a href="#a63d57113242dd466201d5e62a7b42cf8">More...</a><br /></td></tr>
<tr class="separator:a63d57113242dd466201d5e62a7b42cf8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_structBloomberg_1_1quantum_1_1IContextBase"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structBloomberg_1_1quantum_1_1IContextBase')"><img src="../../closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="../../d8/db0/structBloomberg_1_1quantum_1_1IContextBase.html">Bloomberg::quantum::IContextBase</a></td></tr>
<tr class="memitem:a39a012af6799019e99e1ab5364bb2c86 inherit pub_methods_structBloomberg_1_1quantum_1_1IContextBase"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/db0/structBloomberg_1_1quantum_1_1IContextBase.html#a39a012af6799019e99e1ab5364bb2c86">~IContextBase</a> ()=default</td></tr>
<tr class="memdesc:a39a012af6799019e99e1ab5364bb2c86 inherit pub_methods_structBloomberg_1_1quantum_1_1IContextBase"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual destructor.  <a href="../../d8/db0/structBloomberg_1_1quantum_1_1IContextBase.html#a39a012af6799019e99e1ab5364bb2c86">More...</a><br /></td></tr>
<tr class="separator:a39a012af6799019e99e1ab5364bb2c86 inherit pub_methods_structBloomberg_1_1quantum_1_1IContextBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a022df5fbd098b18058823ac74e4491d1 inherit pub_methods_structBloomberg_1_1quantum_1_1IContextBase"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/db0/structBloomberg_1_1quantum_1_1IContextBase.html#a022df5fbd098b18058823ac74e4491d1">valid</a> () const =0</td></tr>
<tr class="memdesc:a022df5fbd098b18058823ac74e4491d1 inherit pub_methods_structBloomberg_1_1quantum_1_1IContextBase"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines if the future object associated with this context has a valid shared state with the corresponding promise.  <a href="../../d8/db0/structBloomberg_1_1quantum_1_1IContextBase.html#a022df5fbd098b18058823ac74e4491d1">More...</a><br /></td></tr>
<tr class="separator:a022df5fbd098b18058823ac74e4491d1 inherit pub_methods_structBloomberg_1_1quantum_1_1IContextBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5cb482148c731b5b9d6866d7e57f962f inherit pub_methods_structBloomberg_1_1quantum_1_1IContextBase"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/db0/structBloomberg_1_1quantum_1_1IContextBase.html#a5cb482148c731b5b9d6866d7e57f962f">validAt</a> (int num) const =0</td></tr>
<tr class="memdesc:a5cb482148c731b5b9d6866d7e57f962f inherit pub_methods_structBloomberg_1_1quantum_1_1IContextBase"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines if the future object associated with the 'num'-th continuation context is still valid.  <a href="../../d8/db0/structBloomberg_1_1quantum_1_1IContextBase.html#a5cb482148c731b5b9d6866d7e57f962f">More...</a><br /></td></tr>
<tr class="separator:a5cb482148c731b5b9d6866d7e57f962f inherit pub_methods_structBloomberg_1_1quantum_1_1IContextBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a084048c88d90de4f3797f18fb3c5fcc4 inherit pub_methods_structBloomberg_1_1quantum_1_1IContextBase"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/db0/structBloomberg_1_1quantum_1_1IContextBase.html#a084048c88d90de4f3797f18fb3c5fcc4">setException</a> (std::exception_ptr ex)=0</td></tr>
<tr class="memdesc:a084048c88d90de4f3797f18fb3c5fcc4 inherit pub_methods_structBloomberg_1_1quantum_1_1IContextBase"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set an exception in the promise associated with the current <a class="el" href="../../da/de3/structBloomberg_1_1quantum_1_1IThreadContext.html" title="Exposes methods to manipulate the thread context.">IThreadContext</a> or <a class="el" href="../../d5/dd1/structBloomberg_1_1quantum_1_1ICoroContext.html" title="Exposes methods to manipulate the coroutine context.">ICoroContext</a>.  <a href="../../d8/db0/structBloomberg_1_1quantum_1_1IContextBase.html#a084048c88d90de4f3797f18fb3c5fcc4">More...</a><br /></td></tr>
<tr class="separator:a084048c88d90de4f3797f18fb3c5fcc4 inherit pub_methods_structBloomberg_1_1quantum_1_1IContextBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_structBloomberg_1_1quantum_1_1ICoroSync"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structBloomberg_1_1quantum_1_1ICoroSync')"><img src="../../closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="../../d3/d63/structBloomberg_1_1quantum_1_1ICoroSync.html">Bloomberg::quantum::ICoroSync</a></td></tr>
<tr class="memitem:a870e1b03e0c0b5a2310709310b78379b inherit pub_methods_structBloomberg_1_1quantum_1_1ICoroSync"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d63/structBloomberg_1_1quantum_1_1ICoroSync.html#a870e1b03e0c0b5a2310709310b78379b">~ICoroSync</a> ()=default</td></tr>
<tr class="memdesc:a870e1b03e0c0b5a2310709310b78379b inherit pub_methods_structBloomberg_1_1quantum_1_1ICoroSync"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default virtual destructor.  <a href="../../d3/d63/structBloomberg_1_1quantum_1_1ICoroSync.html#a870e1b03e0c0b5a2310709310b78379b">More...</a><br /></td></tr>
<tr class="separator:a870e1b03e0c0b5a2310709310b78379b inherit pub_methods_structBloomberg_1_1quantum_1_1ICoroSync"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9639b1f2fad78e3d308bec878a5687f2 inherit pub_methods_structBloomberg_1_1quantum_1_1ICoroSync"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d63/structBloomberg_1_1quantum_1_1ICoroSync.html#a9639b1f2fad78e3d308bec878a5687f2">setYieldHandle</a> (<a class="el" href="../../d6/d86/structBloomberg_1_1quantum_1_1Traits.html#a2730a4e218f1af1a4e3f64e80ed7bbfc">Traits::Yield</a> &amp;<a class="el" href="../../d3/d63/structBloomberg_1_1quantum_1_1ICoroSync.html#a2eca1ca5aa6e819c88a65214289290d4">yield</a>)=0</td></tr>
<tr class="memdesc:a9639b1f2fad78e3d308bec878a5687f2 inherit pub_methods_structBloomberg_1_1quantum_1_1ICoroSync"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the underlying boost::coroutine object so that it can be yielded on.  <a href="../../d3/d63/structBloomberg_1_1quantum_1_1ICoroSync.html#a9639b1f2fad78e3d308bec878a5687f2">More...</a><br /></td></tr>
<tr class="separator:a9639b1f2fad78e3d308bec878a5687f2 inherit pub_methods_structBloomberg_1_1quantum_1_1ICoroSync"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afd376fdf2aa4ffd80ae46f0c87bd3400 inherit pub_methods_structBloomberg_1_1quantum_1_1ICoroSync"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="../../d6/d86/structBloomberg_1_1quantum_1_1Traits.html#a2730a4e218f1af1a4e3f64e80ed7bbfc">Traits::Yield</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d63/structBloomberg_1_1quantum_1_1ICoroSync.html#afd376fdf2aa4ffd80ae46f0c87bd3400">getYieldHandle</a> ()=0</td></tr>
<tr class="memdesc:afd376fdf2aa4ffd80ae46f0c87bd3400 inherit pub_methods_structBloomberg_1_1quantum_1_1ICoroSync"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the underlying boost::coroutine object.  <a href="../../d3/d63/structBloomberg_1_1quantum_1_1ICoroSync.html#afd376fdf2aa4ffd80ae46f0c87bd3400">More...</a><br /></td></tr>
<tr class="separator:afd376fdf2aa4ffd80ae46f0c87bd3400 inherit pub_methods_structBloomberg_1_1quantum_1_1ICoroSync"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2eca1ca5aa6e819c88a65214289290d4 inherit pub_methods_structBloomberg_1_1quantum_1_1ICoroSync"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d63/structBloomberg_1_1quantum_1_1ICoroSync.html#a2eca1ca5aa6e819c88a65214289290d4">yield</a> ()=0</td></tr>
<tr class="memdesc:a2eca1ca5aa6e819c88a65214289290d4 inherit pub_methods_structBloomberg_1_1quantum_1_1ICoroSync"><td class="mdescLeft">&#160;</td><td class="mdescRight">Explicitly yields this coroutine context.  <a href="../../d3/d63/structBloomberg_1_1quantum_1_1ICoroSync.html#a2eca1ca5aa6e819c88a65214289290d4">More...</a><br /></td></tr>
<tr class="separator:a2eca1ca5aa6e819c88a65214289290d4 inherit pub_methods_structBloomberg_1_1quantum_1_1ICoroSync"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1fc5a457c395fd7843ab36de74821fdd inherit pub_methods_structBloomberg_1_1quantum_1_1ICoroSync"><td class="memItemLeft" align="right" valign="top">virtual std::atomic_int &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d63/structBloomberg_1_1quantum_1_1ICoroSync.html#a1fc5a457c395fd7843ab36de74821fdd">signal</a> ()=0</td></tr>
<tr class="memdesc:a1fc5a457c395fd7843ab36de74821fdd inherit pub_methods_structBloomberg_1_1quantum_1_1ICoroSync"><td class="mdescLeft">&#160;</td><td class="mdescRight">Accessor to the underlying synchronization variable.  <a href="../../d3/d63/structBloomberg_1_1quantum_1_1ICoroSync.html#a1fc5a457c395fd7843ab36de74821fdd">More...</a><br /></td></tr>
<tr class="separator:a1fc5a457c395fd7843ab36de74821fdd inherit pub_methods_structBloomberg_1_1quantum_1_1ICoroSync"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a89a2eac3a5f775a2f7306c3d4a10d631 inherit pub_methods_structBloomberg_1_1quantum_1_1ICoroSync"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d63/structBloomberg_1_1quantum_1_1ICoroSync.html#a89a2eac3a5f775a2f7306c3d4a10d631">sleep</a> (const std::chrono::milliseconds &amp;timeMs)=0</td></tr>
<tr class="memdesc:a89a2eac3a5f775a2f7306c3d4a10d631 inherit pub_methods_structBloomberg_1_1quantum_1_1ICoroSync"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sleeps the coroutine associated with this context for <em>at least</em> 'timeMs' milliseconds or 'timeUs' microseconds depending on the overload chosen.  <a href="../../d3/d63/structBloomberg_1_1quantum_1_1ICoroSync.html#a89a2eac3a5f775a2f7306c3d4a10d631">More...</a><br /></td></tr>
<tr class="separator:a89a2eac3a5f775a2f7306c3d4a10d631 inherit pub_methods_structBloomberg_1_1quantum_1_1ICoroSync"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad20289c9f85157b6d76b46aefe401436 inherit pub_methods_structBloomberg_1_1quantum_1_1ICoroSync"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d63/structBloomberg_1_1quantum_1_1ICoroSync.html#ad20289c9f85157b6d76b46aefe401436">sleep</a> (const std::chrono::microseconds &amp;timeUs)=0</td></tr>
<tr class="separator:ad20289c9f85157b6d76b46aefe401436 inherit pub_methods_structBloomberg_1_1quantum_1_1ICoroSync"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Exposes methods to manipulate the coroutine context, especially future wait methods. </p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="aa480ed235fb4eddf594fe5731c54ccab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa480ed235fb4eddf594fe5731c54ccab">&#9670;&nbsp;</a></span>Ptr</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">using <a class="el" href="../../de/d67/structBloomberg_1_1quantum_1_1ICoroContextBase.html#aa480ed235fb4eddf594fe5731c54ccab">Bloomberg::quantum::ICoroContextBase::Ptr</a> =  std::shared_ptr&lt;<a class="el" href="../../de/d67/structBloomberg_1_1quantum_1_1ICoroContextBase.html">ICoroContextBase</a>&gt;</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a6790f4caa9b032241c715803201561f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6790f4caa9b032241c715803201561f4">&#9670;&nbsp;</a></span>wait()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void Bloomberg::quantum::ICoroContextBase::wait </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="../../d3/d63/structBloomberg_1_1quantum_1_1ICoroSync.html#a109b2c4b7d70d53d48bb640a9d849b29">ICoroSync::Ptr</a>&#160;</td>
          <td class="paramname"><em>sync</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Waits for the future associated with this context to be ready. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">sync</td><td>Pointer to the coroutine synchronization object. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>Blocks until the future is ready or until an exception is thrown. </dd></dl>

<p>Implemented in <a class="el" href="../../d8/df7/classBloomberg_1_1quantum_1_1Context.html#a2582bc9f706d742f3473de0f02ff026f">Bloomberg::quantum::Context&lt; RET &gt;</a>.</p>

</div>
</div>
<a id="a63d57113242dd466201d5e62a7b42cf8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a63d57113242dd466201d5e62a7b42cf8">&#9670;&nbsp;</a></span>waitAll()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void Bloomberg::quantum::ICoroContextBase::waitAll </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="../../d3/d63/structBloomberg_1_1quantum_1_1ICoroSync.html#a109b2c4b7d70d53d48bb640a9d849b29">ICoroSync::Ptr</a>&#160;</td>
          <td class="paramname"><em>sync</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Wait for all the futures in the continuation chain to be ready. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">sync</td><td>Pointer to the coroutine synchronization object. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>Blocks until all future values are ready. If any future throws, the exception is swallowed. </dd></dl>

<p>Implemented in <a class="el" href="../../d8/df7/classBloomberg_1_1quantum_1_1Context.html#a06361967cff0da813090d5d19816141b">Bloomberg::quantum::Context&lt; RET &gt;</a>.</p>

</div>
</div>
<a id="a3cbd4fbaab81b30ae8a8ef2eaf7978bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3cbd4fbaab81b30ae8a8ef2eaf7978bc">&#9670;&nbsp;</a></span>waitAt()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void Bloomberg::quantum::ICoroContextBase::waitAt </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>num</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="../../d3/d63/structBloomberg_1_1quantum_1_1ICoroSync.html#a109b2c4b7d70d53d48bb640a9d849b29">ICoroSync::Ptr</a>&#160;</td>
          <td class="paramname"><em>sync</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Waits for the future in the 'num-th' continuation context to be ready. </p>
<p>Allowed range for num is [-1, total_continuations). -1 is equivalent of calling <a class="el" href="../../de/d67/structBloomberg_1_1quantum_1_1ICoroContextBase.html#a6790f4caa9b032241c715803201561f4" title="Waits for the future associated with this context to be ready.">wait()</a> or waitAt(total_continuations-1) on the last context in the chain (i.e. the context which is returned via end()). Position 0 represents the first future in the chain. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">num</td><td>The number indicating which future to wait on. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">sync</td><td>Pointer to the coroutine synchronization object. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>Blocks until the value is ready or an exception is thrown. </dd></dl>

<p>Implemented in <a class="el" href="../../d8/df7/classBloomberg_1_1quantum_1_1Context.html#a45b5235e7557b88a9b044ed030ff95fd">Bloomberg::quantum::Context&lt; RET &gt;</a>.</p>

</div>
</div>
<a id="ac07fda0dfbf94d1c611118d0eb77a275"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac07fda0dfbf94d1c611118d0eb77a275">&#9670;&nbsp;</a></span>waitFor()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual std::future_status Bloomberg::quantum::ICoroContextBase::waitFor </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="../../d3/d63/structBloomberg_1_1quantum_1_1ICoroSync.html#a109b2c4b7d70d53d48bb640a9d849b29">ICoroSync::Ptr</a>&#160;</td>
          <td class="paramname"><em>sync</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::chrono::milliseconds&#160;</td>
          <td class="paramname"><em>timeMs</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Waits for the future associated with this context to be ready for a maximum of 'timeMs' milliseconds. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">sync</td><td>Pointer to the coroutine synchronization object. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">timeMs</td><td>The maximum amount of milliseconds to wait until the future value becomes ready. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>'ready' if value was posted before duration expired or 'timeout' otherwise. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>Blocks until the value is ready, until 'timeMs' duration expires or until an exception is thrown. </dd></dl>

<p>Implemented in <a class="el" href="../../d8/df7/classBloomberg_1_1quantum_1_1Context.html#a39fb2f29e07cd1d5dc185370166605f2">Bloomberg::quantum::Context&lt; RET &gt;</a>.</p>

</div>
</div>
<a id="a15581e24f526c0dfa0b3d3d9bb204a1f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a15581e24f526c0dfa0b3d3d9bb204a1f">&#9670;&nbsp;</a></span>waitForAt()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual std::future_status Bloomberg::quantum::ICoroContextBase::waitForAt </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>num</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="../../d3/d63/structBloomberg_1_1quantum_1_1ICoroSync.html#a109b2c4b7d70d53d48bb640a9d849b29">ICoroSync::Ptr</a>&#160;</td>
          <td class="paramname"><em>sync</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::chrono::milliseconds&#160;</td>
          <td class="paramname"><em>timeMs</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Waits for the future in the 'num-th' continuation context to be ready for a maximum of 'timeMs' milliseconds. </p>
<p>Allowed range for num is [-1, total_continuations). -1 is equivalent of calling <a class="el" href="../../de/d67/structBloomberg_1_1quantum_1_1ICoroContextBase.html#a6790f4caa9b032241c715803201561f4" title="Waits for the future associated with this context to be ready.">wait()</a> or waitAt(total_continuations-1) on the last context in the chain (i.e. the context which is returned via end()). Position 0 represents the first future in the chain. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">num</td><td>The number indicating which future to wait on. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">sync</td><td>Pointer to the coroutine synchronization object. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">timeMs</td><td>The maximum amount of milliseconds to wait until the future value becomes ready. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>'ready' if value was posted before duration expired or 'timeout' otherwise. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>Blocks until the value is ready, until 'timeMs' duration expires or until an exception is thrown. </dd></dl>

<p>Implemented in <a class="el" href="../../d8/df7/classBloomberg_1_1quantum_1_1Context.html#ac1fecdd49135f75ed831a4bb2c327624">Bloomberg::quantum::Context&lt; RET &gt;</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="../../d6/db9/namespaceBloomberg.html">Bloomberg</a></li><li class="navelem"><a class="el" href="../../dc/d48/namespaceBloomberg_1_1quantum.html">quantum</a></li><li class="navelem"><a class="el" href="../../de/d67/structBloomberg_1_1quantum_1_1ICoroContextBase.html">ICoroContextBase</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
  </ul>
</div>
</body>
</html>
